SetTimerInterval

Definition:

SetTimerInterval(control, interval)

 

Description:

Set the timer interval for a Timer Control.

 

Platforms:

All

 

Parameters:

control - required

Name of the Timer Control whose interval you want to change.

 

interval - required

Timer interval in milliseconds as a string value, e.g. "1000".

Specifying "0" (or a value lower than 0) disables the control, any other value enables it.

 

Returns:

nothing

 

Notes:

  • This Method affects Timer Controls placed on a form, it doesn't affect the app-wide Global Timer.

  • A Timer Control will not start until the form containing it has become visible and it has been enabled.

  • An enabled Timer may continue to run after the form containing it has become invisible depending upon the value of its Active on Parent Form Only Property.

  • Controls are only in scope when the form they are defined on is visible and a Script Error, such as "Control <name> does not exist", will occur if an attempt is made to access them when the form is not visible. This means that if a Script run by a Timer Control's OnTimer Event will attempt to access controls on an invisible form, the Timer must be disabled on form unload.

  • You can also enable or disable a Timer and change the timer interval using the SetControlEnabled, ClearControl or SetControlValue Methods.


See also:

ClearControl

GetControlValue

SetControlEnabled

SetControlValue

SetGlobalTimerInterval